孤舟蓑笠翁，独钓寒江雪

Android 组件 -- ContentProvider 使用以及源码分析

发表于 | 分类于 | | 阅读次数
本文介绍 ContentProvider 的基本使用

ContentProvider + SQLite 使用Demo GitHub 源码

概述

ContentProvider 内容提供者，作为 Android 的四大组件之一，我们会经常使用到。它是 Android 中提供的用于数据共享的组件，你可以跨进城、跨应用来访问这些数据。除了跨进程访问数据，ContentProvider 还可以进行跨进程方法调用。
ContentProvider 只是提供了一种跨加成访问数据的能力，和我们本地对于如何操作数据是没有联系的。
对于数据的存储，Android 提供了多种方式供我们选择：SQLite 数据库、Shared Preferences、文件存储等。如果在同一个应用中我们可以直接共享使用这些数据，但是如果时不同的应用需要共享这些数据，那么就需要借助于 ContentProvider。我们平时最常见的是 ContentProvider + SQLite 数据库的组合，当然 ContentProvider 也可以和其他的数据存储方式相结合。
当外部应用需要对 ContentProvider 里面的数据进行增删改查操作时就需要用到 ContentResolver，Andriod 的 Context 提供了 getContentResolver() 方法来获取 ContentResolver 对象。
如果我们使用比如 ContentProvider + Shared Preferences 的组合时，你可能需要将数据转换为 Cursor 返回给 ContentProvider 提供给其他应用查询，那么本文也将介绍如果创建一个 Cursor，通常我们使用 MatrixCursor。
我们也可以使用 ContentProvider + File 的方式来直接操作文件，其他的应用可以通过该方式读写当前应用的私有文件。 这时我们要重写 openFile 等方法来实现。
另外，我们也可以使用 ContentProvider 进行跨进程方法调用。这时我们需要重写 call 方法。根据该方法的参数来调用相对应地方法。

ContentProvider

注册 ContentProvider

创建我们自己的 ContentProvider 需要在 AndroidManifest.xml 中对 ContentProvider 进行注册

1
2
3
4
<provider
    android:authorities="hq.testprovider"
    android:name=".contentprovider.MyContentProvider"
    android:exported="true"/>
  • android:authorities：ContentProvider 的唯一标识符，外部应用可以通过URI中的此属性值来找到想要访问的 ContentProvider，建议用包名来标示，当然你也可以随意指定，但要有唯一性。
  • android:name： ContentProvider 的类名
  • android:exported：是否允许其他应用访问该 ContentProvider，true为允许，false为禁止。
  • android:multiProcess：是否允许在调用者进程启动 ContentProvider。一般情况下，ContentProvider 都是在创建者的进程启动的，如果该进程没有启动，那么会把该进程启动。如果设置了这个属性，就可以在调用者进程启动。但前提是调用者和创建者的 android:sharedUserId 相同才行，否则还是不能在调用者进程启动 ContentProvider。
  • android:initOrder：当前 ContentProvider 相对于其他 ContentProvider 的初始化顺序，数值越大，优先级越高。

封装数据库或者 Shared Preferences

创建我们自己的 ContentProvider 通常需要继承 ContentProvider 类并实现它的六个抽象方法。
ContentProvider 提供了下面的四个抽象方法进行增删改查操作，

1
2
3
4
5
6
7
8
public abstract @Nullable Uri insert(@NonNull Uri uri, @Nullable ContentValues values);
public abstract int delete(@NonNull Uri uri, @Nullable String selection,
            @Nullable String[] selectionArgs);
public abstract int update(@NonNull Uri uri, @Nullable ContentValues values,
            @Nullable String selection, @Nullable String[] selectionArgs);
public abstract @Nullable Cursor query(@NonNull Uri uri, @Nullable String[] projection,
            @Nullable String selection, @Nullable String[] selectionArgs,
            @Nullable String sortOrder);

还有下面两个抽象方法：

1
2
public abstract boolean onCreate();
public abstract @Nullable String getType(@NonNull Uri uri);
  • insert：添加数据。
  • delete：删除数据。
  • update：更新数据。
  • query：查询数据。
  • onCreate：ContentProvider 初始化时调用，一般做一些初始化操作。
  • getType：返回参数中 uri 对应的 MIME 类型，格式比较固定：单条记录为 vnd.android.cursor.item/ 开头的字符串，多条记录为 vnd.android.cursor.dir/ 开头的字符串。一般情况下可以不用去关注，返回null即可。在使用 Intent 时有用。

增删改查方法参数说明：

参数名字 描述 是否可以为空
uri 为数据资源的位置，比如想查询某个表的数据或者想执行某个操作：content://hq.testprovider/table1/ 不能为空
values 想要增加或更新的数据实体 是
projection 相当于 SQL 语法中 SELECT 后面的语句。来表示查询数据时要返回数据的列。比如获取 Student 表中的数据时我们只想要 Student 的名字和地址，那么 projection参数就可以如下表示：new String []{DBOpenHelper.StudentTAB.NAME,DBOpenHelper.StudentTAB.ADDR}，那么返回的 Cursor 中的数据就只有名字和地址两列。 可以为空，表示查询所有列
selection 相当于 SQL 语法中 WHERE 后面的语句。设置的筛选条件，表示接下来的删改查操作只针对符合条件的行进行。这里可以写一些 SQL 语句。DBOpenHelper.StudentTAB.COUNTRY + "=? AND " + DBOpenHelper.StudentTAB.GENDER + "=?" 表示指操作指定国家或者性别的行。或者 DBOpenHelper.StudentTAB.COUNTRY + "='China' AND " + DBOpenHelper.StudentTAB.GENDER + "='male'"，或者 id BETWEEN 10 AND 20 用 between 子句查询某个区间的值。 可以为空，表示，不进行筛选，查询所有列
selectionArgs 配合 selection 使用的参数，将会替换掉 selection 参数中的 ?：new String []{"China", "male"} 。当然也可以写在 selection，效果也是一样的。 可以为空
sortOrder 相当于 SQL 语法中 ORDER BY 后面的语句。为返回数据的排序方式，比如是升序还是降序，还可以添加一些其他的 SQL 字句，比如 updateTime DESC LIMIT 1 OFFSET 1，这个下面会具体介绍 可以为空

依据这些参数，方法的调用后面基本都可以翻译成下的 SQL 语句：

1
2
3
4
SELECT column1, column2....columnN
FROM   table_name
WHERE  column_name BETWEEN val-1 AND val-2 LIMIT [no of rows] OFFSET [row num]
ORDER BY column_name {ASC|DESC} LIMIT [no of rows] OFFSET [row num];

等等。

文件读写

ContentProvider 提供了下面的方法来实现文件共享功能：

  • openAssetFile(@NonNull Uri uri, @NonNull String mode)
  • openFile(@NonNull Uri uri, @NonNull String mode)

方法调用

ContentProvider 提供了下面的方法来跨进程方法调用，当然，不是快进程也是可以的：

  • call(@NonNull String method, @Nullable String arg, @Nullable Bundle extras)

ContentResolver

我们使用 ContentResolver 来对 ContentProvider 的数据进行增删改查的操作。
ContentResolver 对象可以通过 Context.getContentResolver() 来获取，它提供了一系列针对 ContentProvider 操作的方法，和 ContentProvider 里面的方法一一对应。
ContentResolver 提供了 openOutputStream 和 openInputStream 等方法来实现对共享文件的读写。
ContentResolver 提供了 call 方法来对 ContentProvider 提供的方法进行跨进程调用。

openInputStream

Android系统中所有资源都可以用Uri来表示。在获取到资源的Uri后可以通过ContentResolver将其解析成InputStream对象。
这里先对 openInputStream 的源码做简要分析，看看它是如何获取数据的：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
public static final String SCHEME_CONTENT = "content";
public static final String SCHEME_ANDROID_RESOURCE = "android.resource";
public static final String SCHEME_FILE = "file";

public final @Nullable InputStream openInputStream(@NonNull Uri uri)
        throws FileNotFoundException {
    Preconditions.checkNotNull(uri, "uri");
    String scheme = uri.getScheme();
    if (SCHEME_ANDROID_RESOURCE.equals(scheme)) {
        // Note: left here to avoid breaking compatibility.  May be removed
        // with sufficient testing.
        OpenResourceIdResult r = getResourceId(uri);
        try {
            InputStream stream = r.r.openRawResource(r.id);
            return stream;
        } catch (Resources.NotFoundException ex) {
            throw new FileNotFoundException("Resource does not exist: " + uri);
        }
    } else if (SCHEME_FILE.equals(scheme)) {
        // Note: left here to avoid breaking compatibility.  May be removed
        // with sufficient testing.
        return new FileInputStream(uri.getPath());
    } else {
        AssetFileDescriptor fd = openAssetFileDescriptor(uri, "r", null);
        try {
            return fd != null ? fd.createInputStream() : null;
        } catch (IOException e) {
            throw new FileNotFoundException("Unable to create stream");
        }
    }
}

这里会先判断Uri的scheme类型，如果是SCHEME_ANDROID_RESOURCE类型，就先调用getResourceId得到该Uri对应的资源id，然后调用 openRawResource 读取文件到InputStream对象。
如果是SCHEME_FILE类型，就调用uri.getPath()获得文件路径，然后读取文件到FileInputStream对象。
如果是其他类型（比如 assets类型或其他自定义的类型），就调用openAssetFileDescriptor得到一个AssetFileDescriptor对象，然后再得到一个 InputStream对象。

下面举例来介绍一下跨进程实现图片共享的方法：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
InputStream inputStream = null;
try {
    inputStream = getContentResolver().openInputStream(Uri.parse("content://hq.testprovider/getIcon/testPng.png/"));
    final Bitmap bitmap = BitmapFactory.decodeStream(inputStream);

} catch (FileNotFoundException e) {
    e.printStackTrace();
} finally {
    if (inputStream != null) {
        try {
            inputStream.close();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

getIcon 用来标识这是一个获取图片的方法，testPng.png用来标识名称。

在ContentProvider需要重写openTypedAssetFile、openAssetFile或者openFile方法。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
@Nullable
@Override
public ParcelFileDescriptor openFile(Uri uri, String mode) throws FileNotFoundException {
    if (uri != null) {
        if ("content".equals(uri.getScheme())) {
            List<String> list = uri.getPathSegments();
            if (list != null && list.size() ==2) {
                String method = list.get(0);
                if ("getQuickAppIcon".equals(method)){
                    String name = list.get(1);
                    return ParcelFileDescriptor.open(new File(getFilePath(name)), ParcelFileDescriptor.parseMode(mode));
                }
            }
        }
    }
    return super.openFile(uri, mode);
}

ParcelFileDescriptor是android提供的一个数据结构。是可以用于进程间Binder通信的FileDescriptor。支持stream 写入和stream 读出.
我们可以使用

1
public static ParcelFileDescriptor open(File file, int mode)

方法实现将PacecelFileDescriptor 与File对应起来，以实现进程间的文件共享。

call

call方法实现通过ContentProvider实现方法调用：

1
2
3
4
5
6
7
8
9
Uri uri = Uri.parse("content://hq.testprovider/");
Bundle b = new Bundle();
ArrayList<String> list = new ArrayList<>();
list.add("test1.png");
list.add("test2.png");
b.putStringArrayList("iconList",list);
Bundle bundle = getContentResolver().call(uri, "getIconsInfo",null, b);
String result = bundle.getString("iconInfoList");
Log.e("Test","list = "+result);

ContentProvider 重写 call 方法：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
@Nullable
@Override
public Bundle call(@NonNull String method, @Nullable String arg, @Nullable Bundle extras) {
    if ("getIconsInfo".equals(method)) {
        ArrayList<String> list = extras.getStringArrayList("iconList");
        ArrayMap<String, IconBean> map = new ArrayMap<>();
            for (String name : list) {
                IconBean bean = new IconBean();
                IconBean info = getIconInfo(name);
                map.put(name,bean);
            }
        Bundle bundle = new Bundle();
        bundle.putString("iconInfoList", JSON.toJSONString(map));
        return bundle;
    }
    return super.call(method, arg, extras);
}

SQLite 语法

SQLite 教程

LIMIT 和 OFFSET 字句

SQLite Limit 子句

LIMIT <skip>, <count>
等价于
LIMIT <count> OFFSET <skip>

LIMIT <跳过的数据数目>, <取数据数目>
等价于
LIMIT <取数据数目> OFFSET <跳过的数据数目>

其实可以通过 orderby 作假来加上limit offset，反正最后其实也是由db的query去拼接的sql的，如orderby变为 updateTime DESC LIMIT 10 OFFSET 5。

1
getContentResolver().query(uri,null,null,null,"updateTime DESC LIMIT 10 OFFSET 5");

等价于 select * from <table> order by updateTime DESC LIMIT 10 OFFSET 5

LIMIT 和 OFFSET 字句也可以添加在 WHERE 子句后面。

BETWEEN 字句

1
2
3
SELECT column1, column2....columnN
FROM   table_name
WHERE  column_name BETWEEN val-1 AND val-2;

IN 字句

1
2
3
SELECT column1, column2....columnN
FROM   table_name
WHERE  column_name IN (val-1, val-2,...val-N);

SQLiteOpenHelper

数据库操作帮助类，如果我们的 ContentProvider 时结合 SQLite 数据库来实现，那么就会用到这个类。

URI

上面介绍的几个 ContentProvider 几个方法中，大多都有一个 URI 的参数，它表示我们想操作的数据资源的位置。比如：content://hq.testprovider/table1/。
完整的 URI 一般由下面三部分组成：
<standard_prefix>://<authority>/<data_path>/

  • standard_prefix：URI 的前缀，ContentProvider 的前缀为 content://
  • authority：URI 的标识，用于唯一标识这个 ContentProvider。指的是我们在 AndroidManifest.xml 定义的 android:authorities 属性。
  • data_path：路径。一般为要执行的操作的名称或者数据库中的表的名字，也可以自己定义，只要在使用时保持一致就行了。

因此，URI 中的数据包含了需要操作哪个 ContentProvider、以及对 ContentProvider 中哪些数据进行操作的信息。
如果我们是使用 SQLite 来存储数据，那么我们数据库中可能包含多个表，那么 URI 就既要包含操作哪个数据库，也要包含操作数据库中的哪个表。
我们需要执行的一些动作或者调用的方法也可以包含在 URI 中。
那么如何确定一个 UIR 是要执行哪项操作呢？这里需要用到 UriMatcher 来帮忙了。

MatrixCursor

如果我们数据存储用的不是数据库，我们就需要把数据封装成 Cursor 来提供给 ContentProvider。
当我们需要自己创建 Cursor 时，可以使用 Android 为我们提供的 MatrixCursor 类。
下面的例子演示了如何创建一个 MatrixCursor 实例。

1
2
3
MatrixCursor cursor = new MatrixCursor(new String[]{"NAME", "COUNTRY", "TELEPHONE"});
cursor.addRow(new Object[] {"ZhangSan","China",13800000000L});
cursor.addRow(new Object[] {"James","USA",13900000000L});

UriMatcher

UriMatcher 就是用来匹配 URI 的，我们可以在 ContentProvider 中使用 UriMatcher 来注册URI，然后使用 UriMatcher 来匹配 URI 对应的执行动作或者数据表。
UriMatcher 只有两个方法：

  • addURI(String authority, String path, int code)

  • match(Uri uri)

    比如用下面的方法注册 URI：

1
2
3
4
5
6
static final UriMatcher URI_MATCHER = new UriMatcher(UriMatcher.NO_MATCH);
static {
    final UriMatcher matcher = URI_MATCHER;
    matcher.addURI("hq.testprovider", "students", 0x0001);
    matcher.addURI("hq.testprovider", "teachers", 0x0002);
}

然后，根据 URI 来执行对应的动作或者获取对应的数据表进行操作：

1
int match = URI_MATCHER.match(uri);

ContentProviderOperation

为了使批量更新、插入、删除数据更加方便，android系统引入了 ContentProviderOperation类。
在官方开发文档中推荐使用ContentProviderOperations，有以下原因：

  • 所有的操作都在一个事务中执行，这样可以保证数据完整性
  • 由于批量操作在一个事务中执行，只需要打开和关闭一个事务，比多次打开关闭多个事务性能要好些
  • 使用批量操作和多次单个操作相比，减少了应用和ContentProvider之间的上下文切换，这样也会提升应用的性能，并且减少占用CPU的时间，当然也会减少电量的消耗。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
ArrayList<ContentProviderOperation> ops = new ArrayList<ContentProviderOperation>();
ContentProviderOperation operation = ContentProviderOperation.newDelete(uri)
        .withSelection("name=?",new String[]{"James"})
        .build();
ops.add(operation);
ContentProviderOperation operation2 = ContentProviderOperation.newDelete(uri)
        .withSelection("name=?",new String[]{"Wade"})
        .build();
ops.add(operation2);

try {
    getContentResolver().applyBatch(uri.getAuthority(), ops);
} catch (RemoteException e) {
    e.printStackTrace();
} catch (OperationApplicationException e) {
    e.printStackTrace();
}

关于Exception

我们在操作数据库时有必要关系当URI不存在时的一些异常处理，如何处理我们就从源码看一下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
   public final @Nullable Uri insert(@RequiresPermission.Write @NonNull Uri url,
               @Nullable ContentValues values) {
       Preconditions.checkNotNull(url, "url");
       IContentProvider provider = acquireProvider(url);
       if (provider == null) {
           throw new IllegalArgumentException("Unknown URL " + url);
       }
...
   }


   public final int delete(@RequiresPermission.Write @NonNull Uri url, @Nullable String where,
           @Nullable String[] selectionArgs) {
       Preconditions.checkNotNull(url, "url");
       IContentProvider provider = acquireProvider(url);
       if (provider == null) {
           throw new IllegalArgumentException("Unknown URL " + url);
       }
...
   }

   public final int update(@RequiresPermission.Write @NonNull Uri uri,
           @Nullable ContentValues values, @Nullable String where,
           @Nullable String[] selectionArgs) {
       Preconditions.checkNotNull(uri, "uri");
       IContentProvider provider = acquireProvider(uri);
       if (provider == null) {
           throw new IllegalArgumentException("Unknown URI " + uri);
       }
...
   }

   public final @Nullable Cursor query(final @RequiresPermission.Read @NonNull Uri uri,
           @Nullable String[] projection, @Nullable String selection,
           @Nullable String[] selectionArgs, @Nullable String sortOrder,
           @Nullable CancellationSignal cancellationSignal) {
       Preconditions.checkNotNull(uri, "uri");
       IContentProvider unstableProvider = acquireUnstableProvider(uri);
       if (unstableProvider == null) {
           return null;
       }
...
   }

   public final @Nullable Bundle call(@NonNull Uri uri, @NonNull String method,
           @Nullable String arg, @Nullable Bundle extras) {
       Preconditions.checkNotNull(uri, "uri");
       Preconditions.checkNotNull(method, "method");
       IContentProvider provider = acquireProvider(uri);
       if (provider == null) {
           throw new IllegalArgumentException("Unknown URI " + uri);
       }
...
   }

上面列出了增删改查以及 call 方法，发现增删改如果在Uri不存在的情况下都会报 IllegalArgumentException 异常，查询接口在Uri不存在情况下会返回null。因此，我们只需要做相应的异常处理就行了。

ContentProvider 源码分析